fetchTrackingInfoForGlobalMap

fetchTrackingInfoForGlobalMap

Header Parameters

authorization string required

authorization

application/json

Request Body required

request

appointmentStatusList string[]

Possible values: [PENDING_APPROVAL, SCHEDULED, TRIP_IN_PROGRESS, TECHNICIAN_ARRIVED, SERVICE_IN_PROGRESS, SERVICE_COMPLETED, CANCELLED, COMPLETED, DECLINED]

dealerDepartmentUuidList string[]
dealerUuidList string[]
endDate string
requesterUserUuid string
startDate string
techniciansUuidList string[]

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

dealershipCoordinates object[]
Array [
latitude string
longitude string
metaData object
data string
type string
Possible values: [QUERY_LOCATION, DEALERSHIP_ADDRESS, APPOINTMENT_LOCATION]
]
error object
code string
description string
metadata object
property name* string
globalMapDataList object[]
Array [
appointmentUuid string
apptDate string
apptTime string
assignedToUserFirstName string
assignedToUserLastName string
assignedToUserUuid string
customerFirstName string
customerLastName string
customerUuid string
destinationAddress string
destinationLatitude string
destinationLongitude string
lastKnownLocationLatitude string
lastKnownLocationLongitude string
sourceLatitude string
sourceLongitude string
]
statusCode int32
subscribeChannels string[]
subscribeKey string
warnings object[]
Array [
code string
description string
]

{
  "dealershipCoordinates": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "globalMapDataList": [
    {
      "appointmentUuid": "string",
      "apptDate": "string",
      "apptTime": "string",
      "assignedToUserFirstName": "string",
      "assignedToUserLastName": "string",
      "assignedToUserUuid": "string",
      "customerFirstName": "string",
      "customerLastName": "string",
      "customerUuid": "string",
      "destinationAddress": "string",
      "destinationLatitude": "string",
      "destinationLongitude": "string",
      "lastKnownLocationLatitude": "string",
      "lastKnownLocationLongitude": "string",
      "sourceLatitude": "string",
      "sourceLongitude": "string"
    }
  ],
  "statusCode": 0,
  "subscribeChannels": [
    "string"
  ],
  "subscribeKey": "string",
  "warnings": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /track/global-map

Request

Base URL

//api.mykaarma.com/mobile-service

authorization — header required

Body required

{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

python / requests

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

go / native

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/mobile-service/track/global-map' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentStatusList": [
    "PENDING_APPROVAL"
  ],
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuidList": [
    "string"
  ],
  "endDate": "string",
  "requesterUserUuid": "string",
  "startDate": "string",
  "techniciansUuidList": [
    "string"
  ]
}'